Notifications > GNS Utilities > GNS Configuration Tester Utility > Configuring Email Properties

Configuring Email Properties

The Email page of the GNS Configuration Tester defines parameters for the email keywords in the GNS configuration file and provides an interface for testing the email settings.

The following is an example of the Email page of the GNS Configuration Tester dialog box with its corresponding GNS configuration file settings:

GNS Configuration Tester Email page

GNS configuration file settings

Email page of GNS Configuration Tester with corresponding Keywords in the GNS Configuration File

The properties on the Email page of the GNS Configuration Tester dialog box are described here.

If necessary, check with your network administrator or internet service provider to find out the name of your POP and SMTP servers, port numbers, and authentication credentials. These settings also can be changed using the Config File Manager.

To Configure the Email Properties in the GNS Configuration Tester Utility

  1. Start the GNS Configuration Tester. The Email page displays automatically. If this is the first time you have used this utility, the GNS Configuration File box will be empty.
  1. Type a valid file path to the .cfg file in the box, then click Load Config. If the file path does not contain an existing file, then the Load Config button will be disabled. The relevant parameters from the .cfg file will be loaded into the utility.

-OR-

  1. Click the folder icon to browse to the directory that contains the Gns.cfg file, select the file, and click Open. This will automatically load the relevant parameters from the .cfg file into the utility.
  1. In the Authentication Credentials (if needed) area:
  1. Click the check box next to Authentication Credentials (if needed).
  2. Type a Username and Password. Note that authentication may not be required on your network. Check with your network administrator or ISP. Note that these settings also can be changed using the Config File Manager.
  1. In the Incoming POP Server area:
  1. Click the check boxes next to the items you want to edit.
  2. Type the POP3 Server Name and its Port Number. If you are not sure of these properties, check with your network administrator or Internet Service Provider (ISP).
  3. Select the desired Encryption method: SSL/TLS or STARTTLS. See Acknowledging Notifications Via Email for more information about encryption.
  1. In the Outgoing SMTP Server area:
  1. Click the check boxes next to the items you want to edit.
  2. Type the SMTP Server Name and its Port Number. If you are not sure of these properties, check with your network administrator or Internet Service Provider (ISP). See SMTP_TLS_METHOD for information about encrypting outgoing notifications.
  1. In the Message area:
  1. Click the check box next to the From Address.
  2. Type the From Address. This is the "return" address that will show on the email.
  3. The other three message fields are for testing purposes only:
  1. In the To Address box, type an email address for testing retrieve and testing send.
  2. Include a subject line in the Subject box.
  3. Type a message in the Body box.
  1. Click Test Retrieve to retrieve a test message from the POP3 server. You must type a valid email address on the POP3 server in the From Address field to successfully test the retrieve. The Results area will show if the test succeeded or failed.
  1. If the test is successful, the test email will be retrieved immediately and the Results box will show the date and time and "POP retrieve was successful"
  2. If the test failed, review the message in the Results box.
  3. Verify the server information and authentication credentials.
  1. Click Test Send to send a test message. You must type a valid email address in the To Address field to successfully test the send. The Results area will show if the test succeeded or failed.
  1. If the test is successful, the test email will be sent immediately and the Results box will show the date and time and "Message sent to…"
  2. If the test failed, review the message in the Results box.
  3. Verify the server information and authentication credentials. Also verify that the From Address is not blocked by a spam blocker or other network tool.
  1. Click Save Config to save the changes to the Gns.cfg file.
  2. Click Close to exit the utility.
  3. Use CygNet Explorer to stop and restart the GNS for the changes to become effective.
  4. The next time you use this utility the Gns.cfg settings will be automatically loaded.

GNS Configuration Tester Properties — Email

Field Description Associated Gns.cfg File Keyword

GNS Configuration File

The path to the GNS configuration file (Gns.cfg). Click the folder icon to browse to the file on the CygNet host. The relevant parameters from the Gns.cfg file will be loaded into the utility.

N/A

Authentication Credentials (if needed)

Username

The username for the email server, if required. This value is shared by both the POP3 and SMTP email servers. It is required for the Incoming POP3 Server (for receiving acknowledgment reply emails) and optional for the outgoing SMTP Server (for sending SMTP mail messages). The username is encrypted with the common encryption key file.

EMAIL_USERNAME

Password

The user password for the email server, if required. This value is shared by both the POP3 and SMTP email servers. It is required for the Incoming POP3 Server (for receiving acknowledgment reply emails) and optional for the outgoing SMTP Server (for sending SMTP mail messages). The password is encrypted with the common encryption key file. The password for the email server cannot be decrypted, as it is only ever compared against.

EMAIL_PASSWORD

Incoming POP Server

Server Name

Specifies the POP3 server host name or IP address.

Note: You can disable email and SMS acknowledgment by removing the POP3 Server Name and saving the configuration. See Acknowledging Notifications Via Email.

POP3_HOST

Port Number

Specifies the POP3 server send port. The default port is 110.

POP3_PORT

Encryption

Specifies the encryption method used for the incoming POP3 server. Options include: None, SSL/TLS, or STARTTLS.

POP3_TLS_METHOD

Test Retrieve

Click to send and retrieve a test message from the POP3 server using the From Address.

N/A

Outgoing SMTP Server

Server Name

Specifies the SMTP server host name or IP address.

Note: See SMTP_TLS_METHOD for information about encrypting outgoing notifications.

SMTP_HOST

Port Number

Specifies the SMTP server send port. The default port is 25.

SMTP_PORT

Test Send

Click to send a test message from the SMTP server to the email address specified in To Address.

N/A

Message

From Address

Specifies the return address for email notifications, such as name@company.com. This is the "return" address that will show on the outgoing email.

EMAIL_ADDRESS

To Address

Specifies the address where to send a test message. Must be populated to enable the Test Send button.

N/A

Subject

Specifies a subject of the response message.

N/A

Body

Specifies the content of the test message.

N/A

Results

Displays the success or failure of the Test Retrieve or Test Send, including a date and timestamp.

N/A

Back to top

Let us know how we can improve this topic.

CygNet at weatherford.com

© 2020 Weatherford. All rights reserved.